home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / tests / fstrash / RCS / fstrash.man,v < prev   
Encoding:
Text File  |  1990-07-10  |  9.3 KB  |  261 lines
  1. head     1.1;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    jhh:1.1; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.1
  10. date     90.07.09.21.45.39;  author jhh;  state Exp;
  11. branches ;
  12. next     ;
  13.  
  14.  
  15. desc
  16. @@
  17.  
  18.  
  19.  
  20. 1.1
  21. log
  22. @Initial revision
  23. @
  24. text
  25. @' Copyright 1989 Regents of the University of California
  26. ' Permission to use, copy, modify, and distribute this
  27. ' documentation for any purpose and without fee is hereby
  28. ' granted, provided that this notice appears in all copies.
  29. ' The University of California makes no representations about
  30. ' the suitability of this material for any purpose.  It is
  31. ' provided "as is" without express or implied warranty.
  32. ' 
  33. ' $Header: /sprite/lib/forms/RCS/proto.man,v 1.3 89/01/09 11:43:01 ouster Exp $ SPRITE (Berkeley)
  34. ' 
  35. .so \*(]ltmac.sprite
  36. .HS fstrash cmds
  37. .BS
  38. .SH NAME
  39. fstrash \- Produces a completely trashed filesystem.
  40. .SH SYNOPSIS
  41. .nf
  42. \fBfstrash -dev \fIdevice\fP -part \fIpartition\fP [\fIoptions\fR]
  43. .SH OPTIONS
  44. .IP "\fB\-dev\fI device\fR" 14
  45. \fIDevice\fP is the root name of a device, i.e. rxy0, rsd1, rsb0
  46. .IP "\fB\-part\fI partition\fR" 14
  47. \fIPartition\fP is a letter indicating a partition, i.e. a, b, c, d, e, f, g.
  48. .IP "\fB\-dir\fI devDir\fR" 14
  49. \fIDevDir\fR is an alternate directory in which to find the device file
  50. named by concatenating \fIdevice\fR and \fIpartition\fR.  The default 
  51. directory name is ``/dev/``.
  52. .IP "\fB\-initialPart\fI firstPartName\fR" 14
  53. \fIfirstPartName\fP is the name of the initial partition on the disk
  54. which contains basic disk geometry information.  The default is partition
  55. ``a''.
  56. .IP "\fB\-write\fR" 14
  57. Write the disk.  The default is to
  58. not write the disk.
  59. .IP "\fB\-overlap\fR" 14
  60. Overlap filesystem blocks across track boundaries. The default is to not overlap
  61. blocks.
  62. .IP "\fB\-copySuper\fR" 14
  63. Copy the super block to the partition. The default is to not copy.
  64. .IP "\fB\-ratio\fR" 14
  65. Ratio of Kbytes to file descriptors. The default is 4.
  66. .IP "\fB\-test\fR" 14
  67. Don't write to the disk. This is the default.
  68. .IP "\fB\-freeRoot\fR" 14
  69. Set the flag field in the root file descriptor to indicate that it is free.
  70. The default is to mark the root file descriptor as allocated.
  71. .IP "\fB\-fileRoot\fR" 14
  72. Set the filetype field in the root file descriptor to indicate that it is a
  73. file. The default is to make the root a directory.
  74. .IP "\fB\-noRoot\fR" 14
  75. Zero out both the root file descriptor and data block 0. The default is
  76. to fill in the descriptor and to add files to the root.
  77. This option has precedence over both \fB\-freeRoot\fR and \fB\-fileRoot\fR.
  78. .BE
  79.  
  80. .SH DESCRIPTION
  81. .PP
  82. This program produces a trashed file system. It is intended to be used to
  83. test the \fBfscheck\fR program. The above section illustrates the use of the
  84. options. This section outlines the errors that are built into the filesystem
  85. and the actions \fBfscheck\fR should take to correct those errors.
  86. .SS FILE DESCRIPTORS
  87. .LP
  88. The following is a list of the file descriptors, their status in the
  89. file descriptor bitmap, and the file they represent.
  90. .KS
  91. .DS L
  92. .nf
  93. File #        Name                Status
  94. .sp
  95. 0        not used by filesystem        marked
  96. 1        bad blocks            marked
  97. 2        root                marked
  98. 3        "lost+found"            marked
  99. 4        "testFile"            marked
  100. 5        unreferenced file        unmarked
  101. 6        "tooBig"            marked
  102. 7        "tooSmall"            marked
  103. 8         "holeFile"            marked
  104. 9        "holeDir"            marked
  105. 10        "badIndexFile"            marked
  106. 11        "illegalFrag"            marked
  107. 12        "copyBadFrag"            marked
  108. 13        "copyBlock"            marked
  109. 14        "copyIndBlock"            marked
  110. 15        "copyBogusInd"            marked
  111. 16        unreferenced file        unmarked
  112. 17        unreferenced file        marked
  113. 18        "output"            marked
  114. 20        unused but marked        marked
  115. .fi
  116. .DE
  117. .KE
  118. .LP
  119. Fscheck should change the file descriptor bitmap to indicate that files 5 and
  120. 16 are allocated and that file 20 is unallocated. 
  121.  
  122. .SS DATA BLOCKS
  123. .LP
  124. The following is a list of the data blocks, their status in the data block
  125. bitmap and the number of the file that uses them. The block numbers are for
  126. 1k blocks so they actually represent fragments. 
  127.  
  128. .KS
  129. .DS L
  130. .nf
  131. Block #            File #            Status
  132. .sp
  133. 0            2            marked
  134. 1            not used        marked
  135. 4 - 9            3            marked
  136. 10            3            unmarked
  137. 11            3            marked
  138. 12 - 15            6            marked
  139. 16 - 17            7            marked
  140. 20 - 31            8            unmarked
  141. 32 - 39            9            marked
  142. 40 - 43            not used
  143. 44 - 47            10            marked
  144. 48 - 51            10,14            marked
  145. 52 - 55            10,14            marked
  146. 56 - 59            10,13,14,15        marked
  147. 60             12            unmarked
  148. 61            11,12            marked
  149. 62            11,12            marked
  150. 63            12            unmarked
  151. 64            17            marked
  152. 68 - 75            18            marked
  153. .fi
  154. .DE
  155. .KE
  156. .LP
  157. The following blocks should be marked as in use by \fBfscheck\fR: 10, and 20-31.
  158. The following blocks should be marked as not in use: 1, 36-43, and 61.
  159. If the \fB\-delete\fR option of \fBfscheck\fR is not used, then \fBfscheck\fR 
  160. will 
  161. copy
  162. some of disk blocks. This will result in additional disk blocks being
  163. marked as in use. A total of 5 4k blocks are needed. There are two free 4k
  164. blocks in the range 36-43, so depending upon the \fBfscheck\fR implementation 
  165. these blocks may be reused. This would result in their status remaining
  166. unchanged, while 3 previously unused 4k blocks become used.
  167.  
  168. .SS FILES
  169. .LP 
  170. This section contains a description of the problems with each of the files
  171. created by \fBfstrash\fR and the actions \fBfscheck\fR should take to 
  172. correct them.
  173. .IP "File 1 - bad block file descriptor"
  174. File 1 is for bad blocks on the disk. Fscheck should not modify this descriptor
  175. unless the -badBlock option is given, in which case it should reset the
  176. contents of the descriptor.
  177. .IP "File 2 - \fIRoot\fR"
  178. If none of the "*Root" options are given the root directory should not be
  179. affected by \fBfscheck\fR. 
  180. If the \fB\-fileRoot\fR option is given to \fBfstrash\fR,
  181. then \fBfscheck\fR should reconstruct the root directory by adding file 3 
  182. (lost+found) to the root and updating the link count for file 3.
  183. If the \fB\-freeRoot\fR option is used, then \fBfscheck\fR should mark 
  184. file 2 as
  185. in use in addition to adding file 3 to the root.
  186. The \fB\-noRoot\fR option forces \fBfscheck\fR to do a lot of work 
  187. to fix the root.
  188. First, file 2 has to be marked in use. Secondly, any file that is using block
  189. 0 should either have this block deleted or a copy made. File 3 should be
  190. put in the root, and all other files should be put in file 3.
  191. .IP "File 3 - \fIlost+found\fR"
  192. The \fIlost+found\fR directory should be in the root and 
  193. should have its link count
  194. corrected when file 17 (an unreferenced directory) is added to it.
  195. .IP "File 4 - \fItestFile\fR"
  196. \fItestFile\fR is an empty file that is a child of the root. It should not be 
  197. modified by \fBfscheck\fR.
  198. .IP "File 5 - an unreferenced file"
  199. File 5 is an empty, unreferenced file that should be put into lost+found.
  200. .IP "File 6 - \fItooBig\fR"
  201. The size of the file \fItooBig\fR is greater than the amount of
  202. space in its data
  203. blocks. Its length should be truncated to the size of one direct block (4096
  204. bytes).
  205. .IP "File 7 - \fItooSmall\fR"
  206. The size of the file \fItooSmall\fR is smaller than the amount of space in its
  207. data blocks. Direct block 1 (17) should be deleted and its block count 
  208. corrected
  209. from 2 to 1.
  210. .IP "File 8 - \fIholeFile\fR"
  211. \fIholeFile\fR is a file with a hole in most of its direct blocks. 
  212. \fBfscheck\fR should not
  213. modify this file.
  214. .IP "File 9 - \fIholeDir\fR"
  215. Holes are not allowed in directories, so \fBfscheck\fR should 
  216. fill in the hole with empty entries. The hole is in the second direct block.
  217. .IP "File 10 - \fIbadIndexFile\fR"
  218. The \fIbadIndexFile\fR file has an invalid index in its first indirect block.
  219. This block (44) should be deleted so that the file has a hole, and the block
  220. count should be corrected from 1 to 4.
  221. The first direct block pointer is also invalid and should be made a hole.
  222. .IP "File 11 - \fIillegalFrag\fR"
  223. File 11 has a fragment that is not the last block in the file. This fragment
  224. (61)
  225. should be turned into a hole and the block count corrected from 2 to 1.
  226. .IP "File 12 - \fIcopyBadFrag\fR"
  227. The first direct block in file 12 shares one fragment with file 11. 
  228. It should be copied. The second direct block is a fragment that is also shared
  229. with file 11. Only one fragment's worth of data should be copied.
  230. .IP "File 13 - \fIcopyBlock\fR"
  231. This file contains 2 duplicate blocks. Block 0 is reserved for the root
  232. directory and should be either deleted or copied, even if the root directory
  233. doesn't exist. Block 56 is shared with file 10 and should be either copied
  234. or deleted.
  235. The doubly indirect block pointer is invalid (8). Indirect block pointers
  236. are physical block pointers, so the message about a bad pointer may display
  237. the wrong value. The block should be deleted and the size of the file 
  238. reduced to 8192 bytes.
  239. .IP "File 14 - \fIcopyIndBlock\fR"
  240. File 14 shares the doubly indirect block with file 10. New data blocks should
  241. be allocated for the doubly indirect block (48), the indirect block it contains
  242. (52),
  243. and the direct block it contains (56).
  244. .IP "File 15 - \fIcopyBogusIndBlock\fR"
  245. File 15 shares its doubly indirect block with file 10. Block 56 is not
  246. a valid indirect block and should be 
  247. deleted from file 15.
  248. This leaves file 15 with 0 blocks so it should be truncated to length
  249. 0 and the block count corrected from 1 to 0.
  250. .IP "File 16 - bad magic number"
  251. File 16 has a bad magic number and should be marked as free.
  252. .IP "File 17 - unreferenced directory"
  253. File 17 is an unreferenced directory that should be put in lost+found.
  254. The link counts in lost+found and file 17 should be fixed accordingly.
  255. .IP "File 18 - \fIoutput\fR"
  256. File 18 is the output file for saving the results of running fscheck. It
  257. initially has two data blocks allocated to it.
  258. .SH KEYWORDS
  259. filesystem fscheck fsmake
  260. @
  261.